docs(chart): add an upgrade guide and document the commit-driven release - #182
Merged
Conversation
charts/graylog/UPGRADING.md covers 1.0.0 to 2.0.0, grouped by what a reader has to do rather than by commit. Two changes stop the upgrade outright, the imagePullSecrets shape and the native-libs volume claim rename, so those come first with the commands to work around them. MongoDB topology and sizing and the PodDisruptionBudget default come next, because they cost capacity. The rest changes behaviour on its own, including the move to Graylog 7.1.8, the restricted security contexts, the new startup probe and the five-minute shutdown. docs/RELEASING.md described a version-driven flow run by chart-releaser, and linked a workflow that no longer exists. It now covers release-please: what earns a release, how to force a version, how to verify a publication, and a troubleshooting table. It also documents the parser rule that cost the 2.0.0 changelog a chart fix, and the known gaps, publication not being gated on tests among them. CONTRIBUTING.md said releases come from bumping the chart version by hand. It now states that Conventional Commits are required, that the PR title is the subject that lands, that tooling uses ci: or chore:, and that nobody edits Chart.yaml, CHANGELOG.md or the manifest. Release-As: 2.0.0
aaronmgn
approved these changes
Aug 27, 2026
bemcculley-graylog
approved these changes
Aug 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an upgrade guide for 1.0.0 to 2.0.0 and rewrites the release docs, which still described chart-releaser.
Changes
charts/graylog/UPGRADING.md, new. The 16 breaking changes in 2.0.0, grouped by what a reader has to do: change these first, plan capacity for these, these change on their own. Ships in the chart tarball, sohelm pullgets it.docs/RELEASING.md, rewritten for release-please. What earns a release, how to force a version, verification commands, troubleshooting, known gaps. The old version linked.github/workflows/release.yaml, which ci(release): retire chart-releaser, publish the chart from release-please #179 deleted. Closes item 21 indocs/RELEASE_MIGRATION_LOG.md.CONTRIBUTING.md. Conventional Commits are required now, the PR title is the subject that lands, tooling usesci:orchore:, and nobody hand-editsChart.yaml,CHANGELOG.mdor the manifest.This commit sets the next version
The commit body carries
Release-As: 2.0.0, so merging retitles #174 from 1.1.0 to 2.0.0. Eight months of unreleased work includes breaking changes that nobody marked, so release-please computed a minor.Two conditions make that footer work. It has to land on a commit touching
charts/graylog/, whichUPGRADING.mdsatisfies, and the message has to parse. Verified with the parser release-please uses.Keep the body when merging. Dropping it drops the footer, and #174 stays at 1.1.0.
After merge
Confirm #174 reads
chore(main): release graylog 2.0.0. If it still says 1.1.0 the footer did not take, and the fix is another chart-touching commit carrying it, not editingChart.yamlby hand.